Left

data class Left<out L>(value: L) : Either<L, Nothing>

Functions

all

common

inline fun all(predicate: (Nothing) -> Boolean): Boolean

Returns the result of applying the predicate to the value if this is Right or true if this is Left.

any

common

inline fun any(predicate: (Nothing) -> Boolean): Boolean

Returns the result of applying the predicate to the value if this is Right or false if this is Left.

contains

common

open operator override fun contains(element: Any): Boolean

Returns true if the element is equal to the value of this Either, or false otherwise.

filter

common

inline fun filter(predicate: (Nothing) -> Boolean): Either<L, Nothing>?

Returns the same Right if the predicate is satisfied for the value.

filterIsInstance

common

inline fun <T> filterIsInstance(): Either<L, T>?

Returns the same Right casted to type T if it is T.

filterIsInstanceToOption

common

inline fun <T> filterIsInstanceToOption(): Option<Either<L, T>>

Returns Some containing the same Right casted to type T if it is T.

filterNot

common

inline fun filterNot(predicate: (Nothing) -> Boolean): Either<L, Nothing>?

Returns the same Right if the predicate is not satisfied for the value.

filterNotToOption

common

inline fun filterNotToOption(predicate: (Nothing) -> Boolean): Option<Either<L, Nothing>>

Returns Some containing the same Right if the predicate is not satisfied for the value.

filterToOption

common

inline fun filterToOption(predicate: (Nothing) -> Boolean): Option<Either<L, Nothing>>

Returns Some containing the same Right if the predicate is satisfied for the value.

fold

common

inline fun <T> fold(leftTransform: (L) -> T, rightTransform: (Nothing) -> T): T

Transforms Left with leftTransform or Right with rightTransform.

forEach

common

inline fun forEach(action: (Nothing) -> Unit)

Runs action if this is a Right.

get

common

fun get(): Nothing

Gets value of this Right.

getOrNull

common

fun getOrNull(): Nothing?

Gets value of this Right or null if this is Left.

map

common

inline fun <T> map(transform: (Nothing) -> T): Either<L, T>

Maps value of this Right using transform.

none

common

inline fun none(predicate: (Nothing) -> Boolean): Boolean

Returns false if the predicate is met by the value if this is Right or true otherwise.

swap

common

open override fun swap(): Either<Nothing, L>

Swaps Left to Right and Right to Left.

toOption

common

fun toOption(): Option<Nothing>

Returns a Some containing the Right value if it exists, or a None if this is a Left.

Properties

isLeft

common

open override val isLeft: Boolean

Returns true if this is a Left or false if this is Right.

isRight

common

open override val isRight: Boolean

Returns true if this is a Right or false if this is Left.

left

common

val left: LeftProjection<L, Nothing>

Projects Either as Left.

right

common

val right: RightProjection<L, Nothing>

Projects Either as Right.

value

common

val value: L